home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / utils / whati~gz.zoo / whatisin.1z / whatisin
Text File  |  1992-09-12  |  2KB  |  70 lines
  1.  
  2. NAME
  3.     whatisin - show contents of online documentation section
  4.  
  5. SYNOPSIS
  6.     whatisin [ -P path ] [ section ]
  7.  
  8. DESCRIPTION
  9.     The  whatisin  command displays a one line synopsis of each file
  10.     in a specified online documentation section.  To read the actual
  11.     online documentation, use the man(1) command.
  12.  
  13.     The argument section specifies a !section" similar to  those  in
  14.     the 4.2  BSD  UNIX Programmer's Manual (as explained below).  In
  15.     this case, the description of that section is printed along with
  16.     a full list of all documentation in that section.
  17.  
  18.     If  no  section  is  specified,  whatisin  displays  a  list  of
  19.     sections.
  20.  
  21. OPTIONS
  22.     The following switch options are recognized:
  23.  
  24.     -P path
  25.         if  a  valid  path  is  given, whatisin searches for the
  26.         databases there (see ENVIRONMENT).
  27.  
  28. SECTION NAMES
  29.     The sections of the manual are based on  the  Unix  Programmer's
  30.     Manual:
  31.  
  32.     Sect    UNIX Manual    Description
  33.     ----    -----------    -----------
  34.     0    General        overview of features and documentation
  35.     1    Commands    commands (like those in in)
  36.     2    System calls    low-level library calls (C)
  37.     3    Subroutines    standard user calls (C)
  38.     4    Special files    things like emacs .CMD files
  39.     5    File formats    things like arc file formats
  40.     6    Games        games manual
  41.     7    Miscellaneous    miscellaneous information
  42.     8    Maintenance    system administration commands
  43.  
  44.     In addition, whatisin recognizes the following section names:
  45.  
  46.     l    local        files specific to local system
  47.     n    new        files added since current software release
  48.     o    old        files from previous software release
  49.  
  50. ENVIRONMENT
  51.     Whatisin  searches  for  the database file in the directory con-
  52.     tained in the MANPATH environment variable.  Note  that  the  -P
  53.     option overrides  this.  If neither MANPATH or -P are specified,
  54.     a default path of ``d:/usr/man'' is used.
  55.  
  56. FILES
  57.     MANPATH/whatisin.___    manual section list (contents)
  58.     MANPATH/whatis._?_    online documentation database files
  59.  
  60. SEE ALSO
  61.     apropos(1), man(1), whatis(1), whereis(1)
  62.  
  63. AUTHOR
  64.     Bill Rosenkranz
  65.     rosenkra@convex.com
  66.  
  67. VERSION
  68.     whatisin 2.0.1 92/9/12 rosenkra
  69.  
  70.